Skip to main content
Minh Nong
💬
0 discussions

[API] customer-service

API Endpoints​

Tài liệu này nhằm mục đích quản lý số lượng và chức năng của endpoints trong fillter-service. Người đọc có thể dựa vào tên của files và tên endpoints để dễ dàng kiểm tra thông tin apis source code.​

Response​

  • 200: Success
  • 403: Forbidden
  • 400: Bad Request

Auth​

  • Auth Type : Bearer Token

activity.js​

Get all activity method post​

  • Route: /callcenter/:idCallcenter/activities
  • Method: POST
  • Params: idCallcenter
  • Query: versionSchema
  • Body: idAgent, callTags, all, page, limit, from, to, lookup, idGroup, idRole, idTeam, idSessionGroups, query
  • Return Format:
    • Success: 200 { success: true, result, hasMore, count }
    • Failure: 400{ success: false, error: { message: error } }

Get Activities​

  • Route: /callcenter/:idCallcenter/activities
  • Method: GET
  • Params: idCallcenter
  • Query: versionSchema, idAgent, callTags, all, page, limit, from, to, lookup, query
  • Body: ``
  • Return Format:
    • Success: 200 { success: true, result, hasMore, count }
    • Failure: 400{ success: false, error: { message: error } }

Get Activity​

  • Route: /callcenter/:idCallcenter/activity/:idActivity
  • Method: GET
  • Params: idCallcenter, idActivity, idContact
  • Query: versionSchema
  • Body: ``
  • Return Format:
    • Success: 200 { success: true, result: Object.assign({}, result, { tags }) }
    • Failure: 400{ success: false, error: { message: error } }

Get Activity of Contact​

  • Route: /callcenter/:idCallcenter/contact/:idContact/activity/:idActivity
  • Method: GET
  • Params: idCallcenter, idActivity, idContact
  • Query: versionSchema
  • Body: ``
  • Return Format:
    • Success: 200 { success: true, result: Object.assign({}, result, { tags })}
    • Failure: 400{ success: false, error: { message: error } }

Get Activities of contact​

  • Route: /callcenter/:idCallcenter/contact/:idContact/activities
  • Method: GET
  • Params: idCallcenter, idContact
  • Query: type, time, time1, time2, liken, callTags, from, to, page, limit, isReconnected, uuid, status, versionSchema
  • Body: ``
  • Return Format:
    • Success: 200 { success: true, result, hasMore }
    • Failure: 400 { success: false, error: { message: error } }

Get Activities of phone​

  • Route: /callcenter/:idCallcenter/phone/:phone/activities
  • Method: GET
  • Params: idCallcenter, phone
  • Query: versionSchema, type (note, calllog, reminder), time, time1, time2, liken, callTags, from, to, page, limit, isReconnected, status, uuid
  • Body: ``
  • Return Format:
    • Success: 200 { success: true, result, hasMore }
    • Failure: 400 { success: false, error: { message: error } }

Sum Activities​

  • Route: /callcenter/:idCallcenter/activities/sum
  • Method: GET
  • Params: idCallcenter
  • Query: versionSchema, idAgent, idRole, idTeam, filter
  • Body: ``
  • Return Format:
    • Success: 200 { success: true, result: final }
    • Failure: 400{ success: false, error: { message: error } }

Count Activities​

  • Route: /callcenter/:idCallcenter/activities/count
  • Method: GET
  • Params: idCallcenter
  • Query: versionSchema, idAgent, idRole, idTeam, filter
  • Body: ``
  • Return Format:
    • Success: 200 { success: true, result: final }
    • Failure: 400{ success: false, error: { message: error } }

Chart Activities​

  • Route: /callcenter/:idCallcenter/activities/chart
  • Method: GET
  • Params: idCallcenter
  • Query: versionSchema, idAgent, idRole, idTeam, filter
  • Body: ``
  • Return Format:
    • Success: 200 { success: true, result: { outgoing_connected, outgoing_disconnected, incoming_connected, incoming_disconnected } }
    • Failure: 400{ success: false, error: { message: error } }

agentGroup.js​

Get contact groups of agent​

  • Route: /callcenter/:idCallcenter/agentgroup/:idAgent/contactgroups
  • Method: GET
  • Params: idCallcenter, idAgent
  • Query: not, versionSchema
  • Body: ``
  • Return Format:
    • Success: 200 { success: true, result }
    • Failure: 400 { success: false, error: { message: error } }

Get Phones​

  • Route: /callcenter/:idCallcenter/agentgroup/:idAgent/phones
  • Method: GET
  • Params: idCallcenter, idAgent
  • Query: not, versionSchema
  • Body: ``
  • Return Format:
    • Success: 200 { success: true, result }
    • Failure: 400 { success: false, error: { message: error } }

callLog.js​

Get CallLogs​

  • Route: /callcenter/:idCallcenter/calllogs
  • Method: GET
  • Params: idCallcenter
  • Query: idAgent, callTags, all, page, limit, from, to, lookup , versionSchema, query
  • Body: ``
  • Return Format:
    • Success: 200 { success: true, result, hasMore, count }
    • Failure: 400{ success: false, error: { message: error } }

Get CallLog​

  • Route: /callcenter/:idCallcenter/calllog/:idCallLog
  • Method: GET
  • Params: idCallcenter, idCallLog
  • Query: versionSchema
  • Body: ``
  • Return Format:
    • Success: 200 { success: true, result }
    • Failure: 400 { success: false, error: { message: error } }

contact.js​

Get Contact​

  • Route: /callcenter/:idCallcenter/contact/:idContact
  • Method: GET
  • Params: idCallcenter, idContact
  • Query: versionSchema
  • Body: ``
  • Return Format:
    • Success: 200 { success: true, result }
    • Failure: 400 { success: false, error: { message: error } }

Get Contacts​

  • Route: /callcenter/:idCallcenter/contacts
  • Method: GET
  • Params: idCallcenter
  • Query: contactIDs, phones, time, liken, by, order, limit, page, idAgent, all, direction, status, group, sortType, from, to, versionSchema
  • Body: ``
  • Return Format:
    • Success: 200 { success: true, count, hasMore, result }
    • Failure: 400 { success: false, error: { message: error } }

Get Contact By Phone​

  • Route: /callcenter/:idCallcenter/phone
  • Method: GET
  • Params: idCallcenter
  • Query: idAgent, phone, versionSchema
  • Body: ``
  • Return Format:
    • Success: 200 { success: true, result: contact }
    • Failure: 400 { success: false, error: { message: error } }

Search Contact​

  • Route: /callcenter/:idCallcenter/contacts/search
  • Method: GET
  • Params: idCallcenter
  • Query: page, on, mode, q, idAgent
  • Body: ``
  • Return Format:
    • Success: 200 { success: true, result, count }
    • Failure: 400{ success: false, error: { message: error } }

Get Group Of Contact​

  • Route: /callcenter/:idCallcenter/contact/:idContact/groups
  • Method: GET
  • Params: idCallcenter, idContact
  • Query: limit, page, all, versionSchema
  • Body: ``
  • Return Format:
    • Success: 200 {success: true,result: result.splice(0, limit),hasMore}
    • Failure: 400 { success: false, error: { message: error } }

contactField.js​

Get ContactFields​

  • Route: /callcenter/:idCallcenter/contactfields/all
  • Method: GET
  • Params: idCallcenter, versionSchema
  • Query: req.query
  • Body: ``
  • Return Format:
    • Success: 200 { success: true, result }
    • Failure: 400 { success: false, error: { message: error } }

Get ContactField by ID​

  • Route: /callcenter/:idCallcenter/contactfield/:idContactField
  • Method: GET
  • Params: idCallcenter, idContactField
  • Query: filter, limit, page, versionSchema
  • Body: ``
  • Return Format:
    • Success: 200 { success: true, result }
    • Failure: 400 { success: false, error: { message: error } }

contactGroup.js​

Get contacts in group​

  • Route: /callcenter/:idCallcenter/contactGroup/:idContactGroup/contacts
  • Method: GET
  • Params: idCallcenter, idContactGroup
  • Query: limit, page, type, subGroup, direction, status, all, sortType, from, to, versionSchema
  • Body: ``
  • Return Format:
    • Success: 200 { success: true, result: result.splice(0, limit), hasMore, count: total }
    • Failure: 400{ success: false, error: { message: error } }

Get searchContactsInGroup​

  • Route: /callcenter/:idCallcenter/contactGroup/:idContactGroup/contacts/search
  • Method: GET
  • Params: idCallcenter, idContactGroup
  • Query: limit, page, type, subGroup, q , versionSchema
  • Body: ``
  • Return Format:
    • Success: 200 { success: true, count, hasMore,result }
    • Failure: 400 { success: false, error: { message: error } }

Post unionGroup​

  • Route: /callcenter/:idCallcenter/contactGroup/unionGroup
  • Method: POST
  • Params: idCallcenter
  • Query: limit, page, versionSchema
  • Body: groups
  • Return Format:
    • Success: 200 {success: true, hasMore, count, result: listContact}
    • Failure: 400{ success: false, error: { message: error } }

Post differenceGroup​

  • Route: /callcenter/:idCallcenter/contactGroup/diffGroup
  • Method: POST
  • Params: idCallcenter
  • Query: limit, page, versionSchema
  • Body: mainGroup, subGroup
  • Return Format:
    • Success: 200 {success: true, hasMore, count, result: listContact}
    • Failure: 400{ success: false, error: { message: error } }

Get ContactGroup By Id​

  • Route: /callcenter/:idCallcenter/contactgroup/:idContactGroup
  • Method: GET
  • Params: idCallcenter, idContactGroup
  • Query: versionSchema
  • Body: ``
  • Return Format:
    • Success : 200 {success: true, result: contactGroup}
    • Failure : 400 { success: false, error: { message: error } }

Get ContactGroups​

  • Route: /callcenter/:idCallcenter/contactgroups
  • Method: GET
  • Params: idCallcenter
  • Query: idAgent, limit, page, versionSchema
  • Body: ``
  • Return Format:
    • Success: 200 { success: true, result: result.splice(0, limit), hasMore: hasMore }
    • Failure: 400 { success: false, error: { message: error } }

Search ContactGroups​

  • Route: /callcenter/:idCallcenter/contactgroups/search
  • Method: GET
  • Params: idCallcenter
  • Query: idAgent, q, mode, page, limit, versionSchema
  • Body: ``
  • Return Format:
    • Success: 200 { success: true, result: result.splice(0, limit), hasMore }
    • Failure: 400 { success: false, error: { message: error } }

Get Agent Of ContactGroup​

  • Route: /callcenter/:idCallcenter/contactgroup/:idContactGroup/agents

  • Method: GET

  • Params: idCallcenter, idContactGroup

  • Query: versionSchema

  • Body: ``

  • Return Format:

    • Success: 200 { success: true, result }
    • Failure: 400{ success: false, error: { message: error } }

    Get getContactGroupByContact​

  • Route: /callcenter/:idCallcenter/contactGroup/:idContact/contactGroup

  • Method: GET

  • Params: idCallcenter, idContact

  • Query: versionSchema

  • Body: ``

  • Return Format:

    • Success: 200 { success: true, result: group }
    • Failure: 400 { success: false, error: { message: error } }

groupField.js​

Get GroupField​

  • Route: /callcenter/:idCallcenter/groupfield/:id
  • Method: GET
  • Params: idCallcenter, id
  • Query: versionSchema
  • Body: ``
  • Return Format:
    • Success: 200 { success: true, result }
    • Failure: 400 { success: false, error: { message: error }}

Get GroupFields​

  • Route: /callcenter/:idCallcenter/groupfields/all
  • Method: GET
  • Params: idCallcenter
  • Query: req.query, versionSchema
  • Body: ``
  • Return Format:
    • Success: 200 { success: true, result }
    • Failure: 400 { success: false, error: { message: error } }

Template.js​

Get Template​

  • Route: /callcenter/:idCallcenter/templates/all
  • Method: GET
  • Params: idCallcenter
  • Query: req.query, versionSchema
  • Body: ``
  • Return Format:
    • Success: 200 { success: true, result }
    • Failure: 400 { success: false, error: { message: error } }